doc: fix linter warnings and typos in manpage #20741
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/cc @silverwind Also, I propose we eradicate the lowercase form of |
|
sorry for the typo... I totally was just cargo-culting and didn't know that it was Fl and not F1. Thanks for fixing. |
|
No need to apologise, mate. 😉I'm glad I could help. I might be the only Roff-fluent JavaScript programmer on Earth. .if \\n(NX<=1 .if \\n(AJ=0 .if \\n(FT=0 .ll \\n(LLu
.if !\\n(IF \{\
. ps \\n(PS
. ie \\n(VS>=41 .vs \\n(VSu
. el .vs \\n(VSp\}
.ie \\n(IP \{
. \" ACCENTS say \*'e or \*`e to get e acute or e grave both were 4/10
.ds ' \h'\w'e'u*1/10'\z\(aa\h'-\w'e'u*1/10'
.ds ` \h'\w'e'u*2/10'\z\(ga\h'-\w'e'u*2/10'
. \" UMLAUT \*:u, etc.
.if t .ds : \\v'-0.6m'\\h'(1u-(\\\\n(.fu%2u))*0.13m+0.00m'\\z.\\h'0.2m'\\z.\\h'-((1u-(\\\\n(.fu%2u))*0.13m+0.20m)'\\v'0.6m'
.if n .ds : \z"
. \" TILDE and CIRCUMFLEX
.ds ^ \\\\k:\\h'-\\\\n(.fu+1u/2u*2u+\\\\n(.fu-1u*0.13m+0.06m'\\z^\\h'|\\\\n:u'
.ds ~ \\\\k:\\h'-\\\\n(.fu+1u/2u*2u+\\\\n(.fu-1u*0.13m+0.06m'\\z~\\h'|\\\\n:u'I just everybody could read what I'm reading and know how much they could do with it. 😢 |
trivikr
approved these changes
May 17, 2018
jasnell
approved these changes
May 17, 2018
|
Landed in c8e7f8f |
Trott
pushed a commit
to Trott/io.js
that referenced
this pull request
May 17, 2018
Refs: nodejs#19911 PR-URL: nodejs#20741 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rendered preview of updated manpage
Checklist
commit message follows commit guidelinesUncertain how to detail this, as it combines a menial self-explanatory fix (deps: update openssl to 1.0.1j #1 below) and even more menial fixes which aren't self-explanatory (test: don't remove empty.txt on win32 #2 below).
Changes
1. This PR fixes a typo introduced in #19911 with the new
--preserve-symlinks-mainswitch:node/doc/node.1
Line 148 in 810af50
That
F1(U+0046 U+0031) should really beFl(U+0046 U+006C). The "Fl" is an abbreviation for "Flag"In @dgoldstein0's defence, it was an easy mistake to make at a glance, because GitHub's code-font uses awkwardly-similar glyphs for
1andl. However, thanks to my killer work on Roff's syntax highlighting (used on GitHub), the discrepancy is easy to notice:Anyway, the formatted output currently looks like this:
Now, that's actually legal markup, because the
mdocformatter has no way of knowing you didn't mean to insert the textF1. OTOH,.F1would have been caught by the linter, since a line starting with a dot always introduces a command/macro, so it couldn't be misconstrued as being a plain-text line.2. I've removed the redundant use of
\-, which I assume to be cargo-cultShort explanation:
\-is the same as writing-.Long explanation:
No, you don't want the long, painfully circuitous story behind
-VS\-. Trust me, all you need to know now is that for terminal output,\-is always the same as-.The only difference in manpage output is when using older versions of Groff with
-Tutf8set (Groff defaults to-Tasciifor terminal output, so even that's a non-issue. And even that difference is barely noticeable until you copy+paste it. Because in this lone scenario,-(hyphen-minus U+002D) gets replaced by-(minus sign U+2212).3. I've replaced inline font sequences (
\fB…\fR) with mdoc.SycommandsNotice the spaces here?
That's much easier to follow than
(\fB-\fR)and(\fB_\fR), right? That's mdoc doing the hard work behind the scenes for you. When rendered, leading and trailing punctuation like this "closes in on" its contents, producing this:More about delimiter syntax here.